Retrieve all users in the Tenant

Retrieve a list of all users in the tenant, including their assigned licenses and Project roles.

GET{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/users

Headers

HeaderValue
user_idLogin username (email)
api_keyAPI key of the user for authentication
Content-Typeapplication/json
Acceptapplication/json

Parameters

ParameterTypeRequiredDescription
accelqLoginUrlstringYesThe AccelQ login URL for API access.
tenantCodestringYesTenant code for identifying the organization.
user_idstringYesLogin username (email)
api_keystringYesAPI key of the user for authentication

Responses

200 - Successful retrieval of users list

json
[
  {
    "userPid": "26",
    "firstName": "Test",
    "lastName": "User",
    "email": "Testuser@accelq.com",
    "active": true,
    "tenantAdmin": false,
    "assignedLicenses": [
      {
        "subscriptionId": "1724156779826",
        "licenseBundleId": 1,
        "products": [
          "WEB",
          "API"
        ]
      }
    ],
    "assignedProjects": [
      {
        "projectName": "accelq Project",
        "roleName": "SME",
        "isAdmin": false
      }
    ]
  }
]

403 - Forbidden - User does not have permission to view users

json
{
  "error": "User does not have authorization to access this feature"
}

500 - Internal Server Error

json
{
  "error": "Error retrieving user information"
}

cURL Command Builder

URL Parameters

Headers

Request Sample (cURL)

curl -X GET "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/users" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"